H4CK3R 14

home *** CD-ROM | disk | FTP | other *** search

/ H4CK3R 14 / hacker14.iso / programacao / visual / perl.exe / {app} / Library / Perl / perltidy.txt < prev next >

Wrap

Text File | 2003-01-08 | 32.8 KB | 749 lines

NAME perltidy - a Perl script indenter and reformatter SYNOPSIS perltidy [ options ] file1 file2 file3 ... (output goes to file1.tdy, file2.tdy, file3.tdy, ...) perltidy [ options ] file1 -o outfile perltidy [ options ] file1 -st >outfile perltidy [ options ] <infile >outfile DESCRIPTION Perltidy reads a Perl script and writes an indented, reformatted script. The default formatting closely follows the recommendations in perlstyle(1). The formatting can be controlled with input parameters as described in the the section on "OPTIONS" section. The the section on "EXAMPLES" section may contain enough information to get you started. New users may benefit from the short tutorial which comes with the distribution. EXAMPLES These examples illustrate some of the most common parameters. perltidy somefile.pl This will produce a file somefile.pl.tdy containing the script reformatted using the default options. perltidy *.pl Execute perltidy on all .pl files in the current directory with the default options. The output will be in files with an appended .tdy extension. For any file with an error, there will be files with extensions .ERR and .LOG. perltidy -i=3 somefile.pl Execute perltidy on file somefile.pl, with 3 columns for each level of indentation (instead of the default 4 columns). There will not be any tabs in the reformatted script, except for any which already exist in comments, pod documents, quotes, and here documents. Output will be somefile.pl.tdy. perltidy -i=3 -t somefile.pl Same as the previous example, except that each set of 3 columns of indentation will be represented by one leading tab character. perltidy -ce -l=72 somefile.pl Execute perltidy on file somefile.pl with all defaults except use "cuddled elses" and a maximum line length of 72 columns (instead of the default 80 columns). perltidy -io somefile.pl Execute perltidy on file somefile.pl but restrict changes to "indentation only", which means that existing line breaks and whitespace will be unchanged. perltidy -g somefile.pl Execute perltidy on file somefile.pl and save a log file somefile.pl.LOG which shows the nesting of braces, parentheses, and square brackets at the start of every line. OPTIONS The entire command line is scanned for options, and they are processed them before any files are processed. As a result, it does not matter whether flags are before or after any filenames. However, the relative order of parameters is important, with later parameters overriding the values of earlier parameters. For each parameter, there is a long name and a short name. The short names are convenient for keyboard input, while the long names are self-documenting and therefore useful in scripts. It is customary to use two leading dashes for long names, but one may be used. Most parameters which serve as on/off flags can be negated with a leading "n" (for the short name) or a leading "no" (for the long name). For example, the flag to use tabs is -t or --tabs. The flag to use no tabs (the default) is -nt or --notabs. Options may not be bundled together. I/O control -h, --help Show summary of usage and exit. -o=filename, --outfile=filename Name of the output file (only if a single input file is being processed). If no output file is specified, and output is not redirected to the standard output, the output will go to filename.tdy. -st, --standard-output Sends the output script to the standard output. For example, perltidy somefile.pl -st >somefile.new.pl This option may only be used if there is a single input file. -q, --quiet Deactivate error messages and syntax checking (for running under an editor). For example, if you use a vi-style editor, such as vim, you may execute perltidy as a filter from within the editor using something like :n1,n2!perltidy -q where `n1,n2' represents the selected text. Without the -q flag, any error messages will mess up your screen. Besides, it is common to run perltidy on incomplete blocks from an editor, and you don't want to see any complaints about that. (Or maybe you do; in that case, be prepared to use your "undo" key). -syn, --check-syntax This causes perltidy to run `perl -c' to check syntax of input and output. This is the default and highly recommended. The results are written to the .LOG file, which will be saved if an error is detected in the output script. The output script is not checked if the input script has a syntax error. To skip syntax checking, use -nsyn or --nocheck-syntax. Syntax checking is also deactivated by the --quiet flag, discussed above. -log, --logfile Save the .LOG file, which has many useful diagnostics. Perltidy always creates a .LOG file, but by default it is deleted if there are no errors. Setting the -log flag forces the log file to be saved. -g=n, --logfile-gap=n Set maximum interval between input code lines in the logfile. This purpose of this flag is to assist in debugging nesting errors. The value of `n' is optional. If you set the flag -g without the value of `n', it will be taken to be 1, meaning that every line will be written to the log file. This can be helpful if you are looking for a brace, paren, or bracket nesting error. Setting -g also causes the logfile to be saved, so it is not necessary to also include -log. If no -g flag is given, a value of 50 will be used, meaning that at least every 50th line will be recorded in the logfile. This helps prevent excessively long log files. Setting a negative value of `n' is the same as not setting -g at all. -npro --noprofile Ignore any .perltidyrc command file. Normally, perltidy looks first in your current directory for a .perltidyrc file of parameters. (The format is described below). If it finds one, it applies those options to the initial default values, and then it applies any that have been defined on the command line. If no .perltidyrc file is found, it looks for one in your home directory. If you set the -npro flag, perltidy will not look for this file. -opt, --show-options Write a list of all options used to the .LOG file. This is useful for debugging command files. In the list, the status of on/off switches is indicated by a 0 for off and a 1 for on. -f, --force-read-binary Force perltidy to process binary files. Normally, perltidy skips files identified by the system as non-text. This flag causes all existing files to be processed. Basic Options -i=n, --indent-columns=n Use n columns per indentation level (default n=4). See also --tabs. -t, --tabs This flag defines the characters used to indicate the indentation level of each line of code to be tabs. Perltidy allows two possible ways to represent the indentation at the beginning of each line of code. You may either use one tab character per level of indentation (signified with the -t flag), or you may use n real space characters per level, (where n is defined by the -i flag). The choice depends upon which is most convenient for your editor or viewer. The default is to use ASCII space characters because they should be properly displayed on all editors or viewers, even though they are not always the most convenient for editing. Of course, you can always rerun perltidy to change the indentation characters. If you choose tabs, you will want to give the appropriate setting to your editor to display tabs as 4 blanks (or whatever value has been set with the -i command). Except for these possible tab indentation characters, Perltidy does not introduce any tab characters into your file, and it removes any tabs from the code (unless requested not to do so with -fws). If you have any tabs in your comments, quotes, or here-documents, they will remain. -nt, --notabs Use space (blank) characters instead of tabs for leading indentation. This is the default, following the recommendation in perlstyle(1), although many programmers will prefer tabs. -io, --indent-only This flag is used to deactivate all formatting and line break changes. When it is in effect, the only change to the script will be indentation. And any flags controlling whitespace and newlines will be ignored. You might want to use this if you are perfectly happy with your whitespace and line breaks, and merely want perltidy to handle the indentation. Setting this flag is equivalent to setting --freeze-newlines and --freeze-whitespace. Whitespace Control -fws, --freeze-whitespace This flag causes your original whitespace to remain unchanged, and causes the rest of the whitespace commands in this section to be ignored. Tightness of curly braces, parentheses, and square brackets. Here the term "tightness" will mean the closeness with which pairs of enclosing tokens, such as parentheses, contain the quantities within. A numerical value of 0, 1, or 2 defines the tightness, with 0 being least tight and 2 being most tight. The -pt=n or --paren-tightness parameter controls the space within parens. The example below shows the effect of the three possible values, 0, 1, and 2: if ( ( my $len_tab = length( $tabstr ) ) > 0 ) { # -pt=0 if ( ( my $len_tab = length($tabstr) ) > 0 ) { # -pt=1 (default) if ((my $len_tab = length($tabstr)) > 0) { # -pt=2 When n is 0, there is always a space to the right of a '(' and to the left of a ')'. For n=2 there is never a space. For n=1, the default, there is a space unless the quantity within the parens is a single token, such as an identifier or quoted string. Likewise, the parameter -bt=n or --brace-tightness=n controls the space within curly braces, as illustrated in the example below. if ( $Opts{ help } ) { usage(); exit 1; } # -bt=0 if ( $Opts{help} ) { usage(); exit 1; } # -bt=1 (default) if ( $Opts{help} ) {usage(); exit 1;} # -bt=2 And finally, the parameter -sbt=n or --square-bracket-tightness controls the space within square brackets, as illustrated below. $width = $col[ $j + $k ] - $col[ $j ]; # -sbt=0 $width = $col[ $j + $k ] - $col[$j]; # -sbt=1 (default) $width = $col[$j + $k] - $col[$j]; # -sbt=2 -ci=n, --continuation-indentation=n Continuation indentation is extra indentation spaces applied when a long line is broken. The default is n=2, illustrated here: my $level = # -ci=2 ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level; The same example, with n=0, is a little harder to read: my $level = # -ci=0 ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level; -ibc, --indent-block-comments Block comments, meaning full-line comments, normally look best when they are indented to the same level as the code which follows them. This is the default behavior, but you may use -nibc to keep block comments left-justified. Here is an example: # this comment is indented (-ibc, default) if ($task) { yyy(); } -nibc, --noindent-block-comments Do not indent block comments. Here is an example: # this comment is not indented (-nibc) if ($task) { yyy(); } -oll, --outdent-long-lines When -oll is set, lines which cannot be broken into pieces less than the maximum-line-length will have their indentation removed to make them more readable. This is the default. This can mainly occur for long quoted strings and long comments. To prevent such out-denting, use -noll or --nooutdent-long-lines. -msc=n, minimum-space-to-comment=n Side comments look best when lined up several spaces to the right of code. Perltidy will try to keep comments at least n spaces to the right. The default is n=4 spaces. -sts, --space-terminal-semicolon Some programmers prefer a space before all terminal semicolons. The default is for no such space, and is indicated with -nsts or --nospace-terminal-semicolon. $i = 1 ; # -sts $i = 1; # -nsts (default) -sfs, --space-for-semicolon Semicolons within for loops may sometimes be hard to see, particularly when commas are also present. This option places spaces on both sides of these special semicolons, and is the default. Use -nsfs or --nospace-for-semicolon to deactivate it. for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) { # -sfs (default) for ( @a = @$ap, $u = shift @a; @a; $u = $v ) { # -nsfs -asc, --add-semicolons Setting -asc allows perltidy to add any missing optional semicolon at the end of a line which is followed by a closing curly brace on the next line. This is the default, and may be deactivated with -nasc or --noadd-semicolons. -dsc, --delete-semicolons Setting -dsc allows perltidy to delete extra semicolons which are simply empty statements. This is the default, and may be deactivated with -ndsc or --nodelete-semicolons. (Such semicolons are not deleted, however, if they would promote a side comment to a block comment). -aws, --add-whitespace Setting this option allows perltidy to add certain whitespace improve code readability. This is the default. If you do not want any whitespace added, but are willing to have some whitespace deleted, use -naws. (Use -fws to leave whitespace completely unchanged). -dws, --delete-old-whitespace Setting this option allows perltidy to remove some old whitespace between characters, if necessary. This is the default. If you do not want any old whitespace removed, use -ndws or --nodelete-old-whitespace. Line Break Control -fnl, --freeze-newlines If you do not want any changes to the line breaks in your script, set -fnl, and they will remain fixed, and the rest of the commands in this section will be ignored. -l=n, --maximum-line-length=n The default maximum line length is n=80 characters. Perltidy will try to find line break points to keep lines below this length. However, long quotes and side comments may cause lines to exceed this length. -bbc, --blanks-before-comments A blank line will be introduced before a full-line comment. This is the default. Use -nbbc or --noblanks-before-comments to prevent such blank lines from being introduced. -bbs, --blanks-before-subs A blank line will be introduced before a sub definition. This is the default. This is negated with -nbbs or --noblanks-before-subs. -bbb, --blanks-before-blocks A blank line may be introduced before blocks of coding delimited by for, foreach, while, until, and if. This is the default. This is negated with -nbbb or --noblanks-before-blocks. -mbl=n --maximum-consecutive-blank-lines=n This parameter specifies the maximum number of consecutive blank lines in the output script. The default is n=1. If the input file has more than n consecutive blank lines, the number will be reduced to n. -sob, --swallow-optional-blank-lines Blank lines governed by the above flags, -bbb, -bbs, and -bbc, will be deleted. (But essential blank lines above pod documents will be retained). This is NOT the default. -nsob, --noswallow-optional-blank-lines Retain blank lines, including those which do not corresponding to flags -bbb, -bbs, and -bbc. This is the default. The number of blanks retained is subject to the limit imposed by --maximum-consecutive-blank-lines, however. -ce, --cuddled-else Enable the "cuddled else" style, in which `else' and `elsif' are follow immediately after the curly brace closing the previous block. The default is not to use cuddled elses, and is indicated with the flag -nce or --nocuddled-else. Here is a comparison of the alternatives: if ($task) { yyy(); } else { # -ce zzz(); } if ($task) { yyy(); } else { # -nce (default) zzz(); } -bl, --opening-brace-on-new-line Use the flag -bl to place the opening brace on a new line: if ( $input_file eq '-' ) { # -bl This flag applies to all structural blocks, including sub's. The default style, -nbl, places an opening brace on the same line as the keyword introducing it. For example, if ( $input_file eq '-' ) { # -nbl (default) -dnl, --delete-old-newlines By default, perltidy first deletes all old line break locations, and then it looks for optimal break points to match the desired line length. Use -ndnl or --nodelete-old-newlines to force perltidy to retain all old line break points. -anl, --add-newlines By default, perltidy will add line breaks when necessary to create continuations of long lines and to improve the script appearance. Use -nanl or -noadd-newlines to prevent any new line breaks. This flag does not prevent perltidy from eliminating existing line breaks; see -freeze-newlines to completely prevent changes to line break points. Other Controls Writing selected text to a file When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a .TEE extension. This text can include comments and pod documentation. The relevant commands are: -tac or --tee-all-comments, -tbc or --tee-block-comments, -tsc or --tee-side-comments, and -tp or --tee-pod. The negatives of these commands also work, and are the defaults. Deleting selected text Perltidy can selectively delete comments and pod documentation. The commands to do this are: -dac or --delete-all-comments, -dbc or --delete-block-comments, -dsc or --delete-side-comments, and -dp or --delete-pod. The negatives of these commands also work, and are the defaults. Using a .perltidyrc command file Perltidy will first look in your current directory for a command file named .perltidyrc, and if it does not find one, it will look in your home directory. This file is free format, and simply a list of parameters, just as they would be entered on a command line. Any number of lines may be used, with any number of parameters per line, although it may be easiest to read with one parameter per line. Blank lines are ignored, and text after a '#' is ignored to the end of a line. Here is an example of a .perltidyrc file: # This is a simple of a .perltidyrc configuration file # This implements a highly spaced style -bl # braces on new lines -pt=0 # parens not tight at all -bt=0 # braces not tight -sbt=0 # square brackets not tight The parameters in the .perltidyrc file are installed first, so any parameters given on the command line will have priority over them. The parameters in the .perltidyrc file can be completely ignored with the -npro option. Creating a new abbreviation A special notation is available for use in a .perltidyrc file for creating an abbreviation for a group of options. This can be used to create a shorthand for one or more styles which are frequently, but not always, used. The notation is to group the options within curly braces which are preceded by the name of the alias (without leading dashes), like this: newword { -opt1 -opt2 } where newword is the abbreviation, and opt1, etc, are existing parameters *or other abbreviations*. The main syntax requirement is that the new abbreviation must begin on a new line. Space before and after the curly braces is optional. For a specific example, the following line airy {-bl -pt=0 -bt=0 -sbt=0} could be placed in a .perltidyrc file, and then invoked at will with perltidy -airy somefile.pl (Either `-airy' or `--airy' may be used). -sil=n --starting-indentation-level=n By default, perltidy examines the input file and tries to determine the starting indentation level. While it is often zero, it may not be zero for a code snippet being sent from an editing session. If the default method does not work correctly, or you want to change the starting level, use -sil=n, to force the starting level to be n. Controlling list formatting and vertical alignment Perltidy attempts to place comma-separated arrays of values in tables which can be vertically aligned. The number of fields is, by default, chosen to be the largest even number which fits in the current page width (defined by -l=n). Usually this works well. There are two ways to control this formatting. The first is with the use of comments or empty lines. If there are any comments or blank lines between the opening and closing structural brace, parenthesis, or bracket containing the list, then the original line breaks will be used for the entire list instead. The second is with the parameter --mft=n or --maximum-fields-per-table=n. The default value for n is a large number, 40. If the computed number of fields for any table exceeds n, then it will be reduced to n. While this value should probably be left unchanged as a general rule, it might be used on a small section of code to force a list to have a particular number of fields per line, and then a single comment could be introduced somewhere to freeze the formatting in future applications of perltidy. Vertical alignment refers to lining up similar tokens vertically, like this: my $lines = 0; # checksum: #lines my $bytes = 0; # checksum: #bytes my $sum = 0; # checksum: system V sum Once the perltidy vertical aligner "locks on" to a pattern, such as defined by the "=" and "#" in the above example, it retains the pattern for as long as possible. However, a blank line or full-line comment will cause it to forget the pattern and start looking for another. Thus, a single blank line can be introduced to force the aligner to stop aligning when it is undesirable. Making a file unreadable The goal of perltidy is to improve the readability of files, but there are two commands which have the opposite effect, --mangle and --extrude. They are actually merely aliases for combinations of other parameters. Both of these strip all possible whitespace, but leave comments and pod documents, so that they are essentially reversible. The difference between these is that --mangle puts the fewest possible line breaks in a script while --extrude puts the maximum possible. Note that these options do not provided any meaningful obfuscation, because perltidy can be used to reformat the files. A useful application of --mangle is the following: perltidy -mangle myfile.pl -st | perltidy -o myfile.pl.new This is a simple way to clean up a badly formatted script. One-line blocks There are a few points to note regarding one-line blocks. A one-line block is something like this, if ($x > 0) { $y = 1 / $x } where the contents within the curly braces is short enough to fit on a single line. With few exceptions, Perltidy retains existing one-line blocks, if it is possible within the line-length constraint, but it does not attempt to form new ones. In other words, Perltidy will try to follow the one-line block style of the input file. If an existing one-line block is longer than the maximum line length, however, it will be broken into multiple lines. When this happens, perltidy checks for and adds any optional terminating semicolon (unless the -nasc option is used) if the block is a code block. The main exception is that Perltidy will attempt to form new one-line blocks following the keywords `map', `eval', and `sort', because these code blocks are often small and most clearly displayed in a single line. Occasionally it is helpful to introduce line breaks in lists containing a '=>' symbol, which is sometimes called a "comma-arrow". To force perltidy to introduce breaks in a one-line block containing comma arrows, use the --break-after-comma-arrows, or -baa, flag. For example, given the following single line, Perltidy will not add any line breaks: bless { B => $B, Root => $Root } => $package; -nbaa (default) To introduce breaks to show the structure, use -baa: bless { -baa B => $B, Root => $Root } => $package; One-line block rules can conflict with the cuddled-else option. When the cuddled-else option is used, perltidy retains existing one-line blocks, even if they do not obey cuddled-else formatting. Writing an HTML file The flag -html causes perltidy to write an html file with extension .html. So, for example, the following command perltidy -html somefile.pl will produce a syntax-colored html file named somefile.pl.html which may be viewed with a browser. Please Note: In this case, perltidy does not do any formatting to the input file other than indenting it, and it does not write a a formatted file with extension .tdy. This means that, for now, two perltidy runs are required to create a fully reformatted, html copy of a script. (This behavior may change in the future). A default set of colors has been defined, but they may be changed by providing values to any of the following parameters, where n is a 6 digit hex RGB color value: -html-color-xxxxxx=n or -hcx=n where xxxxxx is one of the following words, and x is the corresponding abbreviation: Token Type xxxxxx x ---------- -------- -- number numeric n identifier identifier i bareword, function bareword w keyword keyword k quite, pattern quote q here doc text here-doc-text h here doc target here-doc-target H punctuation punctuation pu parentheses paren p structural braces structural s semicolon semicolon sc colon colon co comma comma cm label label J To illustrate, the following command will produce an html file somefile.pl.html with magenta keywords: perltidy -html -hck=ff00ff somefile.pl Two other character attributes may be set: bold, and italics. To set a token type to use bold, use the flag -html-bold-xxxxxx or -hbx, where xxxxxx or x are the long or short names from the above table. Likewise, to set a token type to use an italic font, use the flag -html-italic-xxxxxx or -hix, where again xxxxxx or x are the long or short names from the above table. For example, to use bold braces and green, bold, italics keywords the following command would be used: perltidy -html -hbs -hck=00FF00 -hik -hbk somefile.pl The background color can be specified with -html-color-background=n, or -hcbg=n for short, where n is a 6 character hex RGB value. The default color of text is the value given to punctuation, which is black as a default. LIMITATIONS Parsing Limitations Perltidy should work properly on most Perl scripts. It does a lot of self-checking, but still, it is possible that an error could be introduced and go undetected. Therefore, it is essential to make careful backups and to test reformatted scripts. The main current limitation is that perltidy does not scan modules included with 'use' statements. This makes it necessary to guess the context of any bare words introduced by such modules. Perltidy has good guessing algorithms, but they are not infallible. When it must guess, it leaves a message in the log file. If you encounter a bug, please report it. What perltidy does not format Perltidy indents but does not reformat comments and `qw' quotes. Perltidy does not in any way modify the contents of here documents or quoted text, even if they contain source code. (You could, however, reformat them separately). And, of course, it does not modify pod documents. FILES Special files when standard input or standard output are used When standard input is used, the log file, if saved, is perltidy.LOG, and any error file is perltidy.ERR. These are saved in the current working directory. If syntax checking is used, a temporary copy of the input file will be created in the current working directory called perltidy.TMPI, but it will be removed when perltidy finishes. When standard output and syntax checking are used, a temporary copy of the output file will be created in the current working directory called perltidy.TMPO. It will be removed when perltidy finishes. Files overwritten The following file extensions are used by perltidy, and files with these extensions may be overwritten or deleted: .tdy, .ERR, .LOG, .TEE, .TMPI, .TMPO. Files extensions limitations Perltidy does not operate on files for which the run could produce a file with a duplicated file extension. These extensions are .tdy, .LOG, .ERR, .TEE, .TMPI, .TMPO. The purpose of this rule is to prevent generating confusing filenames such as somefile.tdy.tdy.tdy. SEE ALSO perlstyle(1) VERSION This man page documents perltidy version 20010303. AUTHOR Steven L. Hancock email: perltidy at users.sourceforge.net http://perltidy.sourceforge.net COPYRIGHT Copyright (c) 2000, 2001 by Steven L. Hancock LICENSE This package is free software; you can redistribute it and/or modify it under the terms of the "GNU General Public License". Please refer to the file "COPYING" for details. DISCLAIMER This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the "GNU General Public License" for more details.